Design documentation
Contents |
[edit] Introduction
Documentation is the process, act or instance of classifying, annotating or authenticating information contained within documents for purposes of factual verification or permanent record keeping. A document is a representation of information in a written, drawn or digital form.
Design documentation is a term that is sometimes associated with the development of computer software (as in architecture design documentation) and web design (as in user experience or UX). In Design Documentation: Why You Need It, Nick Babich provides an overview of the basic ideas of design documentation for UX. This includes:
- Making documentation usable for the target audience.
- Providing up-to-date documentation.
- Working on design documentation incrementally.
- Testing documentation.
- Avoiding jargon.
- Creating easy access.
- Providing visual samples in the documentation.
Generally, this sort of design documentation should include information about users, implementation details, agreed upon decisions and project deadlines. The creation of design documentation should take place during the early stages of a project in order to clarify expectations and expedite the achievement of goals.
[edit] Building design documentation
These same basic principles can apply to design documentation for building and construction. At the very least, there should be a suitable amount of documentation written to inform staff at an appropriate level of the work that they are expected to complete.
Ideally, this collection of documents and resources should cover all design aspects of a building project, including decisions that have been made during the design process to satisfy business, legal, environmental, social, technical and so on requirements and support the execution of the design.
This can include specifications, drawings, operational information, and other relevant documents (explanatory diagrams, tables and charts, standards, surveys and so on).
The amount and depth of the documentation will depend on the requirements of the design brief, and other documentation such as employers information requirements.
There are a number of articles on Designing Buildings describing particular types of documentation and documents:
- Contract documents.
- Tender documentation.
- Types of drawings.
- Briefing documents.
- Specifications.
- Legislation.
- Regulations.
- Planning permission.
- Certificates.
- Permits.
- Approvals.
- BIM.
- Construction contract certificates, notices and instructions.
For more information see: Design process.
[edit] Related articles on Designing Buildings
- Commissioning documentation.
- Document.
- Handover to client.
- Project brief for design and construction.
- Quality management systems (QMS) - beyond the documentation.
- Record keeping.
- User experience UX.
[edit] External resources
- Nick Babich, Design Documentation: Why You Need It.
Featured articles and news
Electrotechnical excellence, now open for entries.
Net zero electricity grids BSRIA guide NZG 5/2024
Outlining the changes needed to transition to net zero.
CIOB Global Student Challenge 2024
Universitas Indonesia wins for second year running.
New project and cultural district described in detail.
The nature of EPCs, crticism and inaccuracies.
History, issues and redesign.
From waste recycling to energy performance the hierchy.
An introduction to WERCS and WEEE responsibilities
Dealing with 2 million tonnes of waste equipment a year.
Global BACS Market: analytics and optimisation
A BSRIA glance at building automation and control systems.
What it is and how to use it.
Types of insulating plaster by binder and insulant.
Investors in People: CIOB achieves gold
Reflecting a commitment to employees and members.
Scratching beneath the surface; a guide to selection.
ECA 2024 Apprentice of the Year Award
Entries open for submission until May 31.
UK gov apprenticeship funding from April 2024
Brief summary the policy paper updated in March.
For the World Autism Awareness Month of April.